Broadband Availability API

1.4.x
(0 reviews)

Version History

Version 1.4

Released 13 August 2021

New Hyperfibre fields included in this release.

Method / FeatureDescription
"ponVariants"A new Array of ponVariants that provides a list of different passive optical network speed variants available at a given location. Following are the elements in the array.
Speed = INTEGER (1000, 4000, 8000)Indicates the PON speed available at the given address.
availabilityStatus: VARCHAR (Unplanned, Ready, Unknown, Under Build, Planned)The status of the fibre roll out. If the status is equal to Ready then the address is Capable for a given PON Speed.
availabilityDate = DATEIndicates the availability date for the relevant PON Speed at a given address.
installLeadTime: INTEGER (35)The potential lead time needed for the fibre installation at a given address. This is dependent on the Chorus infrastructure available for the address.
Version 1.3

Released 9 September 2019

The Broadband Availability API version 1.3 adds 3 additional fields to the existing address information.

Features included in this release:

Method / FeatureDescription
ffpID=STRINGIndicates the FFP a given Address is connected to. RSPs can use this information to determine which FFP a given address is connected to.
fibreUnbundlingEnabled=Y/NIndicates if a given address is eligible for fibre unbundling. RSPs can use this information to determine if a given address can be unbundled.
fibreUnbundlingDate=DATEIndicates the fibre unbundling date if a given address is eligible for fibre unbundling. RSPs can use this information to determine when a given address can be unbundled
Version 1.2

Released 29 July 2019

The Broadband Availability API version 1.2 introduces a new parameter into the existing Fibre Availability Information.

This version contains no breaking changes and will continue to function without the need for consumers to change the end points or URLs.

Features included in this release:

Method / Feature Description
fibreInstallLeadTime=STRING

The potential lead time needed for the fibre installation at a given address.

The Fibre Install Lead Time is identified when 20% of the appointments in the schedule of appointments are unassigned for three consecutive working days. Appointments may be available before the stated lead time. However, it provides an indication of when our technician availability will increase. Lead times do not account for complicated installations or consenting processes, which can vary from property to property.

Our connection times assume that you are available for your scoping and installation appointments which are booked for you. Times also assume that your modem supplied by your broadband provider is available for installation.

There are a number of factors that can impact lead and installation times including:

  • Weather, particularly for digging and trenching
  • Local council approvals and the Resource Management Act
  • Time taken for completed orders to be lodged with Chorus by your broadband provider
  • Consenting process for your property
  • Specific installation requirements for your property
Version 1.1

Released 17 June 2019

The Broadband Availability API version 1.1 adds new fields to show if:

1 an address can have a same day installation
2 the connection is vectoring enabled
3 we recommend a connection and wiring field service for a VDSL capable line to achieve the VDSL speed benefits.

Features included in this release:

Method / FeatureDescription
fibreInADayCapable=Y/NIndicates if the address can have the scoping and installation done on the same day; without requiring 2 separate appointments.
vectoringEnabled=TRUE/FALSEIndicates if the premise is connected to a cabinet that is vectoring enabled.
premiseWiringRecommended=Y/NWhere the address is VDSL capable, this field will indicate whether a Connection and Wiring field service is strongly recommended to achieve the VDSL speed benefits.
permitDelayLikely=Y/NThere will be a likely delay on this property to acquire permits for working on third party poles, or to organise traffic management. This will be determined at the scope appointment, and next steps will be provided at that stage.
Version 1.0

Released 8 February 2018

Features included in this release:

Method / Feature Description
GET services/{id} - Retrieve broadband availability information by either PLSAM or TLC
  • Which services are active Broadband Products currently active at an address. For example, an address may have an active VDSL service.
  • Which broadband products are currently available to be provisioned at the address.
  • Current and potential speeds that can be achieved for broadband products at an address.
  • The status of the Chorus fibre rollout at the address.
  • The status of the fibre build at the address.
  • The status of any consents required for the fibre build at the address.
  • Details of the network equipment serving the address.
  • The UFB or RBI area which the address falls within.

Reviews